API Documentation
Static Public Member Functions | List of all members
nkScripts::ContentLoader Class Referencefinal

Allows to export and import content through their declaration files. More...

Static Public Member Functions

static nkExport::ExporterLoadResult inputData (const nkMemory::StringView &filePath)
 
static nkMemory::String inputDataStr (const nkMemory::StringView &filePath)
 
static nkExport::ExporterLoadResult inputDataSources (const nkMemory::StringView &sources)
 
static bool outputData (const nkMemory::StringView &content, const nkMemory::StringView &path)
 
static bool saveTreeDeclaration (nkExport::Node *tree, const nkMemory::StringView &pathFromData)
 
static bool saveObjectDeclaration (nkExport::Exportable *object, const nkMemory::StringView &pathFromData)
 
static ContentLoadResultScript loadScriptDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultScript processScriptSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultScript processScriptTree (nkExport::Node *tree, bool loadResource=true)
 

Detailed Description

Allows to export and import content through their declaration files.

Member Function Documentation

◆ inputData()

static nkExport::ExporterLoadResult nkScripts::ContentLoader::inputData ( const nkMemory::StringView filePath)
static

Inputs data from a file and returns associated tree, if parsing can occur. It will use Json parsing.

Parameters
filePathThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The result after loading designated file.

◆ inputDataStr()

static nkMemory::String nkScripts::ContentLoader::inputDataStr ( const nkMemory::StringView filePath)
static

Loads the file into a string for easy access.

Parameters
filePathThe path of the file to load from.
Returns
The loaded file in a string.

◆ inputDataSources()

static nkExport::ExporterLoadResult nkScripts::ContentLoader::inputDataSources ( const nkMemory::StringView sources)
static

Inputs data from memory and returns associated tree, if parsing can occur. It will use Json parsing.

Parameters
sourcesThe sources to parse.
Returns
The result after loading designated memory chunk.

◆ outputData()

static bool nkScripts::ContentLoader::outputData ( const nkMemory::StringView content,
const nkMemory::StringView path 
)
static

Writes data to a file.

Parameters
contentThe content to write.
pathThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ saveTreeDeclaration()

static bool nkScripts::ContentLoader::saveTreeDeclaration ( nkExport::Node tree,
const nkMemory::StringView pathFromData 
)
static

Saves a tree into a file.

Parameters
treeThe tree to export.
pathFromDataThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ saveObjectDeclaration()

static bool nkScripts::ContentLoader::saveObjectDeclaration ( nkExport::Exportable object,
const nkMemory::StringView pathFromData 
)
static

Saves an exportable into a file.

Parameters
objectThe object to serialize and export.
pathFromDataThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ loadScriptDeclaration()

static ContentLoadResultScript nkScripts::ContentLoader::loadScriptDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a Script declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceIf the importing should ultimately load the scripts found or not.
Returns
The result of the process attempt.

◆ processScriptSources()

static ContentLoadResultScript nkScripts::ContentLoader::processScriptSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a Script declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceIf the importing should ultimately load the scripts found or not.
Returns
The result of the process attempt.

◆ processScriptTree()

static ContentLoadResultScript nkScripts::ContentLoader::processScriptTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a Script declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceIf the importing should ultimately load the script or not.
Returns
The result of the process attempt.

The documentation for this class was generated from the following file: